home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / dev / asm / revtimer.lha / RevTimer / RevTimer.doc < prev    next >
Text File  |  1995-03-20  |  5KB  |  146 lines
  1. ---------------------------------------------------------------------------
  2.                               RevTimer 1.03                       20-Mar-95
  3. ---------------------------------------------------------------------------
  4.  
  5. Introduction
  6. ~~~~~~~~~~~~
  7. This is a little program, that reads the system clock, and saves it in
  8. four environment variables, called Date, VerDate, Day and Time - once a
  9. second (or as often as specified).
  10.  
  11. The reason why I did this, was that I wanted an easy way to get the date
  12. into my programs.
  13.  
  14. As the assembler I use can't run arexx/dos scripts, and I keep forgetting
  15. to put the current date into the program, I did this program.
  16.  
  17. Requires OS2.04 (V37).
  18.  
  19. Disclaimer
  20. ~~~~~~~~~~
  21. THIS SOFTWARE AND INFORMATION IS PROVIDED "AS IS".  NO REPRESENTATIONS OR
  22. WARRANTIES ARE MADE WITH RESPECT TO THE ACCURACY, RELIABILITY, PERFORMANCE,
  23. CURRENTNESS, OR OPERATION OF THIS SOFTWARE AND INFORMATION, AND ALL USE IS
  24. AT YOUR OWN RISK.  THE AUTHOR DOES NOT ASSUME ANY RESPONSIBILITY OR
  25. LIABILITY WHATSOEVER WITH RESPECT TO YOUR USE OF THIS SOFTWARE AND
  26. INFORMATION.
  27.  
  28. Copyright
  29. ~~~~~~~~~
  30. This program is FREEWARE.  It may be freely distributed as long as all
  31. files in it remain unchanged and are included in the distribution.  Also no
  32. more than a nominal copy fee may be charged for the distribution.  This
  33. program cannot be used for commercial purposes without written permission
  34. from the author.
  35.  
  36. Function
  37. ~~~~~~~~
  38. RevTimer can be run from both CLI and Workbench.  It should be placed in
  39. the WBStartup drawer.
  40.  
  41. To start the program, just double-click on its icon or enter the name of
  42. the program from the CLI.
  43.  
  44. The program can be quitted by double-clicking on its icon when it is
  45. already running or by using the 'Commodities Exchange'.
  46.  
  47. Use the tooltype 'DONOTWAIT' if you are using the program from the
  48. WBStartup drawer (the tooltype is set by default).
  49.  
  50. There are also some other tooltypes that can be used to change some defaults
  51. for the program (this can not be done from CLI).
  52.  
  53. UPDATETIME - If you eg. only want the date to be written once a minute, then
  54.              you can use this.
  55.  
  56. TIME       - If you don't want the Time to be written, use this.
  57.  
  58. DATE       - If you don't want the Date to be written, use this.
  59.  
  60. DAY        - If you don't want the Day to be written, use this.
  61.  
  62. VERDATE    - If you don't want the VerDate to be written, use this.
  63.  
  64. Here comes some examples:
  65.  
  66. 1/
  67.  
  68. UPDATETIME=60   ; Update variables once a minute
  69. TIME=YES        ; Write time
  70. DATE=NO         ; Don't write date
  71. DAY=NO          ; Don't write day
  72. VERDATE=YES     ; Write date in canadian format (used for version strings)
  73.  
  74. 2/
  75.  
  76. UPDATETIME=10   ; Update every ten seconds.
  77. TIME=NO         ; No time
  78. DATE=YES        ; Use date
  79. DAY=YES         ; Use day
  80. VERDATE=NO      ; No VerDate
  81.  
  82. Default is:
  83.  
  84. UPDATETIME=1    ; Write the date once a second
  85. TIME=YES        ; Write the time (eg. 13:49:11)
  86. DATE=YES        ; Write the date (eg. 10-Dec-94)
  87. DAY=YES         ; Write the day (eg. Saturday)
  88. VERDATE=YES     ; Write the date (eg. 10.12.94)
  89.  
  90.  
  91. To use the dates in assembler:
  92.  
  93. DATE:   IncBin  ENV:Date        ; The format is: DD-MMM-YY
  94. VERDATE:IncBin  ENV:VerDate     ; The format is: DD.MM.YY
  95. TIME:   IncBin  ENV:Time        ; The format is: HH:MM:SS
  96. DAY:    IncBin  ENV:Day         ; The full dayname.
  97.  
  98. ---------------------------------------------------------------------------
  99.  
  100. Here comes the format for the version string. I copied this from the
  101. document file for the program 'RIVer' by Chris P. Vandierendonck. I hope
  102. he doesn't mind that I copied it...
  103.  
  104.        EVID (Embedded Version ID) structure
  105.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  106.          The standard format (AmigaDOS) of an EVID structure is as
  107.          follows :
  108.  
  109.            $VER: <name> <version>.<revision> (<dd>.<mm>.<yy>)
  110.  
  111.          Field explanation -> <name>     : name of the program or file
  112.                               <version>  : major version number
  113.                               <revision> : minor version number
  114.                               <dd>       : creation day 
  115.                               <mm>       : creation month (numeric)
  116.                               <yy>       : creation year
  117.  
  118.          After this text sequence, most programs include a comment.
  119.  
  120.          All my programs support this EVID code,  but  the  structure  has
  121.          been extended. (This has no effect on the correct functioning  of
  122.          the AmigaDOS command 'Version'!).
  123.  
  124.  
  125.          The extended format (AmiSYS format) is as follows :
  126.                               
  127.            $VER: <name> <version>.<revision> (<dd>.<mm>.<yy>/
  128.            <hh>:<mm>:<ss>/<devcode>) <comment>
  129.  
  130.          Field explanation -> <hh>      : hour created
  131.                               <mm>      : minutes of hour created
  132.                               <ss>      : seconds of hour created
  133.                               <devcode> : code  used  in  development   of
  134.                                           program 
  135.                               <comment> : copyright notice 
  136.  
  137. ---------------------------------------------------------------------------
  138.  
  139.  
  140.              Send bug reports, ideas, PD Programs etc. to:
  141.  
  142.                            Staffan Hämälä
  143.                            Pellov. 268
  144.                            S-957 93 Pello
  145.                            SWEDEN
  146.